home *** CD-ROM | disk | FTP | other *** search
/ SGI Performance Co-Pilot 1.3 / SGI Performance Co-Pilot 1.3.iso / dist / dist6.4 / pcp.idb / usr / share / catman / u_man / cat3 / PMAPI / _pmparsemetricspec.z.z / _pmparsemetricspec.z / _pmparsemetricspec
Text File  |  1997-04-03  |  6KB  |  67 lines
  1.  
  2.  
  3.  
  4. ____PPPPMMMMPPPPAAAARRRRSSSSEEEEMMMMEEEETTTTRRRRIIIICCCCSSSSPPPPEEEECCCC((((3333))))                                    ____PPPPMMMMPPPPAAAARRRRSSSSEEEEMMMMEEEETTTTRRRRIIIICCCCSSSSPPPPEEEECCCC((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ____ppppmmmmPPPPaaaarrrrsssseeeeMMMMeeeettttrrrriiiiccccSSSSppppeeeecccc - parse uniform metric specification
  10.  
  11. CCCC SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ####iiiinnnncccclllluuuuddddeeee <<<<ppppccccpppp////iiiimmmmppppllll....hhhh>>>>
  13.  
  14.      iiiinnnntttt ____ppppmmmmPPPPaaaarrrrsssseeeeMMMMeeeettttrrrriiiiccccSSSSppppeeeecccc((((cccchhhhaaaarrrr ****ssssttttrrrriiiinnnngggg,,,, iiiinnnntttt iiiissssaaaarrrrcccchhhh,,,, cccchhhhaaaarrrr ****ssssoooouuuurrrrcccceeee,,,,
  15.      ____ppppmmmmMMMMeeeettttrrrriiiiccccSSSSppppeeeecccc ********rrrrsssslllltttt,,,, cccchhhhaaaarrrr ********eeeerrrrrrrrmmmmssssgggg))))
  16.  
  17.      cccccccc ............ ----llllppppccccpppp
  18.  
  19. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  20.      ____ppppmmmmPPPPaaaarrrrsssseeeeMMMMeeeettttrrrriiiiccccSSSSppppeeeecccc accepts a ssssttttrrrriiiinnnngggg specifying the name of a PCP
  21.      performance metric, and optionally the source (either a hostname or an
  22.      archive log filename) and instances for that metric.
  23.  
  24.      If current values for a metric are to be fetched, the accepted format is
  25.      "hhhhoooosssstttt:mmmmeeeettttrrrriiiicccc[iiiinnnnssssttttaaaannnncccceeee1111,,,,iiiinnnnssssttttaaaannnncccceeee2222 ............]".  If values are to be fetched from
  26.      a PCP archive log, the accepted format is
  27.      "aaaarrrrcccchhhhiiiivvvveeee/mmmmeeeettttrrrriiiicccc[iiiinnnnssssttttaaaannnncccceeee1111,,,,iiiinnnnssssttttaaaannnncccceeee2222 ............]".  The "hhhhoooosssstttt:", "aaaarrrrcccchhhhiiiivvvveeee/" and
  28.      "[iiiinnnnssssttttaaaannnncccceeee1111,iiiinnnnssssttttaaaannnncccceeee2222 ............]"  components are optional.  White space is
  29.      ignored at the beginning and end of the ssssttttrrrriiiinnnngggg and around the delimiters
  30.      ":", "/", "[", "]" and ",".  The "," delimiter may be replaced by white
  31.      space.  Special characters in iiiinnnnssssttttaaaannnncccceeee names may be escaped by
  32.      surrounding the name in double quotes or preceding the character with a
  33.      backslash.
  34.  
  35.      If neither hhhhoooosssstttt nor aaaarrrrcccchhhhiiiivvvveeee is specified, the iiiissssaaaarrrrcccchhhh and ssssoooouuuurrrrcccceeee arguments
  36.      are used to fill in the returned ____ppppmmmmMMMMeeeettttrrrriiiiccccSSSSppppeeeecccc structure.
  37.  
  38.      The ____ppppmmmmMMMMeeeettttrrrriiiiccccSSSSppppeeeecccc structure that represents the parsed string has the
  39.      following declaration:
  40.  
  41.          typedef struct {
  42.              int     isarch;      /* source type: 0 -> host, 1 -> archive */
  43.              char    *source;     /* name of source host or archive */
  44.              char    *metric;     /* name of metric */
  45.              int     ninst;       /* number of instances, 0 -> all */
  46.              char    *inst[1];    /* array of instance names */
  47.          } _pmMetricSpec;
  48.  
  49.      ____ppppmmmmPPPPaaaarrrrsssseeeeMMMMeeeettttrrrriiiiccccSSSSppppeeeecccc returns 0 if the given ssssttttrrrriiiinnnngggg was successfully parsed.
  50.      In this case all the storage allocated by ____ppppmmmmPPPPaaaarrrrsssseeeeMMMMeeeettttrrrriiiiccccSSSSppppeeeecccc can be
  51.      released by a single call to ffffrrrreeeeeeee(3C) with the address of the returned
  52.      ____ppppmmmmMMMMeeeettttrrrriiiiccccSSSSppppeeeecccc structure as argument.  ____ppppmmmmPPPPaaaarrrrsssseeeeMMMMeeeettttrrrriiiiccccSSSSppppeeeecccc returns -1 and a
  53.      dynamically allocated error message string in eeeerrrrrrrrmmmmssssgggg, if the given ssssttttrrrriiiinnnngggg
  54.      does not parse.  Be sure to ffffrrrreeeeeeee(3C) the error message string.
  55.  
  56. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  57.      PPPPMMMMAAAAPPPPIIII(3), ____ppppmmmmPPPPaaaarrrrsssseeeeIIIInnnntttteeeerrrrvvvvaaaallll(3) ____ppppmmmmPPPPaaaarrrrsssseeeeCCCCttttiiiimmmmeeee(3) ____ppppmmmmPPPPaaaarrrrsssseeeeAAAAnnnnyyyyTTTTiiiimmmmeeee(3) and
  58.      ____ppppmmmmCCCCoooonnnnvvvveeeerrrrttttTTTTiiiimmmmeeee(3).
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.